/*
 * Copyright (c) 2020 - present, Inspur Genersoft Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.inspur.edp.sgf.api.service;

import com.inspur.edp.lcm.metadata.api.entity.GspMetadata;
import com.inspur.edp.sgf.api.common.ResourceType;

/**
 * 功能描述:Eapi设计时元数据接口服务
 *
 * @ClassName: EapiMetadataDtService
 * @Author: Fynn Qi
 * @Date: 2020/12/23 9:28
 * @Version: V1.0
 */
public interface EapiMetadataDtService {

    /**
     * 创建元数据
     * 使用场景：低代码，元数据文件形式存在
     *
     * @param metadata     依赖的元数据，如视图对象
     * @param path         EAPI需要创建的路径
     * @param resourceType 外部服务资源类型
     * @return 外部服务元数据实体
     */
    GspMetadata create(GspMetadata metadata, String path, ResourceType resourceType);

    /**
     * 创建元数据
     * 使用场景：零代码，元数据会持久化到数据库中
     *
     * @param metadata     依赖的元数据实体，如视图对象
     * @param resourceType 资源类型
     * @return 外部服务元数据实体
     */
    GspMetadata create(GspMetadata metadata, ResourceType resourceType);

    /**
     * 全量更新外部服务元数据
     * 使用场景：零代码，元数据会持久化到数据库中
     *
     * @param eapiMetadataId 外部服务元数据ID
     * @param metadata       依赖的元数据实体，如视图对象
     * @param resourceType   资源类型
     * @return 更新后的外部服务元数据实体
     */
    GspMetadata update(String eapiMetadataId, GspMetadata metadata, ResourceType resourceType);

    /**
     * 发布服务
     * 使用场景：零代码，元数据会持久化到数据库中
     *
     * @param metadataId 外部服务元数据ID
     */
    void publish(String metadataId);

}
